API 參考手冊

本《卡巴斯基安全管理中心 OpenAPI 參考手冊》旨在協助完成以下工作:

在《OpenAPI 參考手冊》中,您可以使用螢幕右側的搜尋欄位找出您所需的資訊。

unloc_icon_API_open OPENAPI 參考手冊

指令碼範例

OpenAPI 參考指南包含下表中列出的 Python 指令碼範例。這些範例展示如何調用 OpenAPI 方法並自動完成各種網路防護工作,例如,建立一個“主要/從屬”階層結構,在卡巴斯基安全管理中心中執行工作,或分配發佈點。您可以按原樣執行範例,也可以根據範例建立自己的指令碼。

要調用 OpenAPI 方法並執行指令碼:

  1. 下載 KlAkOAPI.tar.gz 存檔。此存檔包括 KlAkOAPI 套件和範例(您可以從存檔或 OpenAPI 參考指南中復制它們)。KlAkOAPI.tar.gz 存檔也位於卡巴斯基安全管理中心安裝資料夾中。
  2. 從安裝了管理伺服器的裝置上的 KlAkOAPI.tar.gz 存檔安裝 KlAkOAPI 套件

    您只能在安裝了管理伺服器和 KlAkOAPI 套件的裝置上調用 OpenAPI 方法、執行範例和您自己的指令碼。

    符合使用者方案和卡巴斯基安全管理中心 OpenAPI 方法的樣本

    樣本

    樣本目的

    情景

    記錄 KlAkParams

    您可以使用 KlAkParams 資料結構來擷取與處理資料。該範例顯示如何使用此資料結構。

    範例輸出可以以不同的方式呈現。您可以取得資料來傳送 HTTP 方法或在您的程式碼中使用它。

    監控和報告

    建立和刪除“主要/從屬”層級結構

    您可以新增次要管理伺服器,進而建立「主要 / 次要」層級。或者,您可以中斷次要管理伺服器與層級結構的連線。

    根據 Active Directory 單位結構建立群組階層結構

    您可以輪詢 Active Directory 單位結構並形成已發現之裝置群組的層次結構。

    建立管理群組

    根據快取的 Active Directory 單位結構建立群組階層結構

    您可以根據之前輪詢的 Active Directory 單位結構形成受管理裝置群組的階層結構。如果新裝置在上次輪詢後出現在 Active Directory 中,則不會將它們新增到群組中,因為它們不在儲存的輪詢結果中。

    建立管理群組

    透過連線閘道下載網路清單檔案到指定裝置

    您可以透過使用連線閘道連線到所需裝置的網路代理,然後將包含網路清單的檔案下載到您的裝置。

    發佈點和連線閘道器的調整

    將儲存在主管理伺服器儲存區中的產品授權金鑰安裝到從屬管理伺服器上

    您可以連線到主管理伺服器,從其下載所需的產品授權金鑰,然後將此金鑰傳輸到層次結構中包含的所有從屬管理伺服器。

    受管理應用程式的產品授權

    建立有效的使用者權限報告

    您可以建立不同的報告。例如,您可以使用此範例產生有效的使用者權限報告。此報告描述了使用者擁有的權限,具體取決於他或她的群組和角色而定。

    您可以下載 HTML、PDF 或 Excel 格式的報告。

    生成和瀏覽報告

    為裝置啟動工作

    您可以透過使用連線閘道連線到所需裝置上的網路代理,然後執行必要的工作。

    手動啟動工作

    根據 Active Directory 站點和服務建立 IP 子網路

    您可以根據您使用的 Active Directory 單位結構建立 IP 子遮罩。

    該範例啟動對指定 IP 範圍的輪詢並刪除發現的子遮罩,以避免它們與新子遮罩發生衝突。因此,請勿在需要保留子遮罩的網路中執行此範例。

    輪詢後,範例會參考 Active Directory,檢查其中的每個裝置,並建立 IP 子遮罩。為此,範例會使用所有裝置的遮罩和 IP 位址。

    配置網路防護

    為群組中的裝置註冊分發點

    您可以將受管理裝置分配為發佈點(以前稱為更新代理)。

    更新 Kaspersky 資料庫和應用程式

    列舉所有群組

    您可以對管理群組採取以下操作。該範例顯示如何執行以下操作:

    • 取得「受管理裝置」根群組的識別碼
    • 在群組階層結構中移動
    • 獲取完整的、擴展的群組階層結構及其名稱和嵌套

    設定管理伺服器

    列舉工作、查詢工作統計並執行工作

    您可以找到以下資訊:

    • 工作進度記錄
    • 目前工作狀態
    • 不同狀態的工作數量

    您還可以執行工作。預設情況下,範例會在輸出統計資訊後執行工作。

    監視工作執行

    建立並執行工作

    您可以建立工作。在範例中指定以下工作參數:

    • 類型
    • 執行方法
    • 名稱
    • 將使用工作的裝置群組

    預設情況下,範例會建立一個「顯示訊息」類型的工作。您可以為管理伺服器的所有受管理裝置執行此工作。如有需要,您可以指定自己的工作參數

    建立工作

    列舉產品授權金鑰

    您可以獲得安裝在管理伺服器受管理裝置上之卡巴斯基應用程式的所有啟動產品授權金鑰的清單。該清單包含關於每個產品授權金鑰的詳細資料,例如名稱、類型或到期日期。

    檢視使用中產品授權金鑰的相關資訊

    建立與尋找內部使用者

    您可以建立一個帳戶以進行進一步的工作。

    選取帳戶以啟動管理伺服器

    建立一個自訂類別

    您可以根據需要建立應用程式類別參數

    建立含有手動新增內容的應用程式類別

    使用 SrvView 列舉使用者

    您可以使用 SrvView 類別請求獲得管理伺服器的詳細資料。例如,您可以使用此範例取得使用者清單。

    管理使用者帳戶

透過 OpenAPI 與卡巴斯基安全管理中心互動的應用程式

一些應用程式透過 OpenAPI 與卡巴斯基安全管理中心互動。例如,此類應用程式包括 Kaspersky Anti Targeted Attack Platform 或 Kaspersky Security for Virtualization。這也可以是您基於 OpenAPI 開發的自訂用戶端應用程式。

透過 OpenAPI 與卡巴斯基安全管理中心互動的應用程式連線至管理伺服器。如果您配置了一個連線至管理伺服器的 IP 位址允許清單,請新增安裝了使用卡巴斯基安全管理中心 OpenAPI 的應用程式的裝置的 IP 位址。要了解您使用的應用程式是否透過 OpenAPI 工作,請參閱此應用程式的説明。

頁頂